<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: ipc::transport::error Namespace Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Public API.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceipc.html">ipc</a></li><li class="navelem"><a class="el" href="namespaceipc_1_1transport.html">transport</a></li><li class="navelem"><a class="el" href="namespaceipc_1_1transport_1_1error.html">error</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle"><div class="title">ipc::transport::error Namespace Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Namespace containing the <a class="el" href="namespaceipc_1_1transport.html" title="Flow-IPC module providing transmission of structured messages and/or low-level blobs (and more) betwe...">ipc::transport</a> module's extension of <a class="el" href="namespaceboost_1_1system.html" title="Small group of miscellaneous utilities to ease work with boost.system, joining its boost::system name...">boost.system</a> error conventions, so that that API can return codes/messages from within its own new set of error codes/messages.  
<a href="namespaceipc_1_1transport_1_1error.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:adfef15ef4e76cc55d652fbd9c2797297"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297">Code</a> { <br />
&#160;&#160;<a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297a42d41c622e92e9053177ba73e75633fe">S_SENDS_FINISHED_CANNOT_SEND</a> = S_CODE_LOWEST_INT_VALUE
, <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297aad44f87d53255ba573d57086dfeab805">S_RECEIVES_FINISHED_CANNOT_RECEIVE</a>
, <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297adc5d7b9dbaa8c76c6835e3c9a7942410">S_LOW_LVL_TRANSPORT_HOSED_CANNOT_SEND</a>
, <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297a1fba28e335d4189cbb25f382582efcc1">S_LOW_LVL_TRANSPORT_HOSED_CANNOT_RECEIVE</a>
, <br />
&#160;&#160;<a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297acb14cace6f75d915cd800113c37721e7">S_LOW_LVL_TRANSPORT_HOSED</a>
, <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297a8c068cf7b73b09b5ed3fa3532de1747c">S_LOW_LVL_UNEXPECTED_STREAM_PAYLOAD_BEYOND_HNDL</a>
, <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297adde24987f30a92b953297207ce935210">S_MESSAGE_SIZE_EXCEEDS_USER_STORAGE</a>
, <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297ae3753569086cc66c6165480bd8d2f937">S_BLOB_RECEIVER_GOT_NON_BLOB</a>
, <br />
&#160;&#160;<a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297aba920b52e9801e4927dd346ad83ce815">S_RECEIVER_IDLE_TIMEOUT</a>
, <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297a41cb789a6a5da26e1f72139206cb9adf">S_PROTOCOL_NEGOTIATION_OPPOSING_VER_INVALID</a>
, <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297a594bf33052a89403c734f24428007c80">S_PROTOCOL_NEGOTIATION_OPPOSING_VER_TOO_OLD</a>
, <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297ac416e988563e44bf15fc6a81743eef53">S_INVALID_ARGUMENT</a>
, <br />
&#160;&#160;<a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297abcfca4c2347f9d377dd2ac41c41dc027">S_TIMEOUT</a>
, <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297a291f8a813c292ccdb475c345181653ac">S_INTERRUPTED</a>
, <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297afe29343445a7bf167cc186a44bd2c6ed">S_OBJECT_SHUTDOWN_ABORTED_COMPLETION_HANDLER</a>
, <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297a9ee20939f859e44681c24f6d153cc36b">S_MQ_MESSAGE_SIZE_OVER_OR_UNDERFLOW</a>
, <br />
&#160;&#160;<a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297a515698d19c829006a0803477fb605ae3">S_MQ_BIPC_MISC_LIBRARY_ERROR</a>
, <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297a5026917d99ad25df8bc708cc6628f28c">S_BLOB_STREAM_MQ_SENDER_EXISTS</a>
, <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297af6ee4717280d29cc272ef2a356ad3982">S_BLOB_STREAM_MQ_RECEIVER_EXISTS</a>
, <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297a0ba1798bc135b43eebd7ce2481151348">S_BLOB_STREAM_MQ_RECEIVER_BAD_CTL_CMD</a>
, <br />
&#160;&#160;<a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297aa667487757f9d6300f6888bac40bcc24">S_SYNC_IO_WOULD_BLOCK</a>
, <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297a6fba12db09e5bebfaa04f6372c41c2cf">S_END_SENTINEL</a>
<br />
 }</td></tr>
<tr class="memdesc:adfef15ef4e76cc55d652fbd9c2797297"><td class="mdescLeft">&#160;</td><td class="mdescRight">All possible errors returned (via <code>Error_code</code> arguments) by <a class="el" href="namespaceipc_1_1transport.html" title="Flow-IPC module providing transmission of structured messages and/or low-level blobs (and more) betwe...">ipc::transport</a> functions/methods <em>outside of</em> system-triggered errors such as <code>boost::asio::error::connection_reset</code>.  <a href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297">More...</a><br /></td></tr>
<tr class="separator:adfef15ef4e76cc55d652fbd9c2797297"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aa825718d46992654588588b09a0f1be6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1transport_1_1error.html#aa825718d46992654588588b09a0f1be6">make_error_code</a> (<a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297">Code</a> err_code)</td></tr>
<tr class="memdesc:aa825718d46992654588588b09a0f1be6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Given a <code>Code</code> <code>enum</code> value, creates a lightweight <a class="el" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89" title="Short-hand for flow::Error_code which is very common.">Error_code</a> (a/k/a <a class="el" href="namespaceboost_1_1system.html" title="Small group of miscellaneous utilities to ease work with boost.system, joining its boost::system name...">boost.system</a> <code>error_code</code>) representing that error.  <a href="namespaceipc_1_1transport_1_1error.html#aa825718d46992654588588b09a0f1be6">More...</a><br /></td></tr>
<tr class="separator:aa825718d46992654588588b09a0f1be6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4686a04e7ab89d4be42548cbb5b37975"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1transport_1_1error.html#a4686a04e7ab89d4be42548cbb5b37975">operator&lt;&lt;</a> (std::ostream &amp;os, <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297">Code</a> val)</td></tr>
<tr class="memdesc:a4686a04e7ab89d4be42548cbb5b37975"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes a <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297" title="All possible errors returned (via Error_code arguments) by ipc::transport functions/methods outside o...">transport::error::Code</a> to a standard output stream.  <a href="namespaceipc_1_1transport_1_1error.html#a4686a04e7ab89d4be42548cbb5b37975">More...</a><br /></td></tr>
<tr class="separator:a4686a04e7ab89d4be42548cbb5b37975"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a64595c41a5810937c39733230628c499"><td class="memItemLeft" align="right" valign="top">std::istream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1transport_1_1error.html#a64595c41a5810937c39733230628c499">operator&gt;&gt;</a> (std::istream &amp;is, <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297">Code</a> &amp;val)</td></tr>
<tr class="memdesc:a64595c41a5810937c39733230628c499"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deserializes a <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297" title="All possible errors returned (via Error_code arguments) by ipc::transport functions/methods outside o...">transport::error::Code</a> from a standard input stream.  <a href="namespaceipc_1_1transport_1_1error.html#a64595c41a5810937c39733230628c499">More...</a><br /></td></tr>
<tr class="separator:a64595c41a5810937c39733230628c499"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a5c632f91e295b0061c8d51b7278c843e"><td class="memItemLeft" align="right" valign="top"><a id="a5c632f91e295b0061c8d51b7278c843e" name="a5c632f91e295b0061c8d51b7278c843e"></a>
constexpr int&#160;</td><td class="memItemRight" valign="bottom"><b>S_CODE_LOWEST_INT_VALUE</b> = 1</td></tr>
<tr class="memdesc:a5c632f91e295b0061c8d51b7278c843e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Numeric value of the lowest Code. <br /></td></tr>
<tr class="separator:a5c632f91e295b0061c8d51b7278c843e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Namespace containing the <a class="el" href="namespaceipc_1_1transport.html" title="Flow-IPC module providing transmission of structured messages and/or low-level blobs (and more) betwe...">ipc::transport</a> module's extension of <a class="el" href="namespaceboost_1_1system.html" title="Small group of miscellaneous utilities to ease work with boost.system, joining its boost::system name...">boost.system</a> error conventions, so that that API can return codes/messages from within its own new set of error codes/messages. </p>
<p >Note that many errors <a class="el" href="namespaceipc_1_1transport.html" title="Flow-IPC module providing transmission of structured messages and/or low-level blobs (and more) betwe...">ipc::transport</a> might report are system errors and would not draw from this set of codes/messages but rather from <code>boost::asio::error</code> or <code>boost::system::errc</code> (possibly others). (If you're familiar with the <a class="el" href="namespaceboost_1_1system.html" title="Small group of miscellaneous utilities to ease work with boost.system, joining its boost::system name...">boost.system</a> framework, you'll know such mixing is normal &ndash; in fact arguably one of its strengths.)</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespaceipc_1_1transport_1_1struc_1_1error.html" title="Analogous to ipc::transport::error but applies to the sub-namespace ipc::transport::struc – errors ha...">ipc::transport::struc::error</a> which covers errors from the <em>structured</em> layer (<a class="el" href="namespaceipc_1_1transport_1_1struc.html" title="Sub-module of Flow-IPC module ipc::transport providing transmission of structured messages specifical...">ipc::transport::struc</a>). The present namespace applies to unstructured/lower-level traffic or to both that and structured/higher-level.</dd></dl>
<p>See flow's <code>flow::net_flow::error</code> doc header which was used as the model for this and similar. As of this writing there is discussion there useful for someone new to <a class="el" href="namespaceboost_1_1system.html" title="Small group of miscellaneous utilities to ease work with boost.system, joining its boost::system name...">boost.system</a> error reporting. </p>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="adfef15ef4e76cc55d652fbd9c2797297" name="adfef15ef4e76cc55d652fbd9c2797297"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adfef15ef4e76cc55d652fbd9c2797297">&#9670;&nbsp;</a></span>Code</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">enum class <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297">ipc::transport::error::Code</a></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>All possible errors returned (via <code>Error_code</code> arguments) by <a class="el" href="namespaceipc_1_1transport.html" title="Flow-IPC module providing transmission of structured messages and/or low-level blobs (and more) betwe...">ipc::transport</a> functions/methods <em>outside of</em> system-triggered errors such as <code>boost::asio::error::connection_reset</code>. </p>
<p >These values are convertible to <a class="el" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89" title="Short-hand for flow::Error_code which is very common.">Error_code</a> (a/k/a <code>boost::system::error_code</code>) and thus extend the set of errors that <a class="el" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89" title="Short-hand for flow::Error_code which is very common.">Error_code</a> can represent. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="adfef15ef4e76cc55d652fbd9c2797297a42d41c622e92e9053177ba73e75633fe" name="adfef15ef4e76cc55d652fbd9c2797297a42d41c622e92e9053177ba73e75633fe"></a>S_SENDS_FINISHED_CANNOT_SEND&#160;</td><td class="fielddoc"><p >Will not send message: local user already ended sending via API marking this. </p>
</td></tr>
<tr><td class="fieldname"><a id="adfef15ef4e76cc55d652fbd9c2797297aad44f87d53255ba573d57086dfeab805" name="adfef15ef4e76cc55d652fbd9c2797297aad44f87d53255ba573d57086dfeab805"></a>S_RECEIVES_FINISHED_CANNOT_RECEIVE&#160;</td><td class="fielddoc"><p >Will not receive message: either opposing user sent graceful-close via API. </p>
</td></tr>
<tr><td class="fieldname"><a id="adfef15ef4e76cc55d652fbd9c2797297adc5d7b9dbaa8c76c6835e3c9a7942410" name="adfef15ef4e76cc55d652fbd9c2797297adc5d7b9dbaa8c76c6835e3c9a7942410"></a>S_LOW_LVL_TRANSPORT_HOSED_CANNOT_SEND&#160;</td><td class="fielddoc"><p >Unable to send outgoing traffic: an earlier-reported, or at least logged, system error had hosed the underlying transport mechanism. </p>
</td></tr>
<tr><td class="fieldname"><a id="adfef15ef4e76cc55d652fbd9c2797297a1fba28e335d4189cbb25f382582efcc1" name="adfef15ef4e76cc55d652fbd9c2797297a1fba28e335d4189cbb25f382582efcc1"></a>S_LOW_LVL_TRANSPORT_HOSED_CANNOT_RECEIVE&#160;</td><td class="fielddoc"><p >Unable to receive incoming traffic: an earlier-reported, or at least logged, system error had hosed the underlying transport mechanism. </p>
</td></tr>
<tr><td class="fieldname"><a id="adfef15ef4e76cc55d652fbd9c2797297acb14cace6f75d915cd800113c37721e7" name="adfef15ef4e76cc55d652fbd9c2797297acb14cace6f75d915cd800113c37721e7"></a>S_LOW_LVL_TRANSPORT_HOSED&#160;</td><td class="fielddoc"><p >Unable to access low-level details: an earlier-reported system error had hosed the underlying transport mechanism. </p>
</td></tr>
<tr><td class="fieldname"><a id="adfef15ef4e76cc55d652fbd9c2797297a8c068cf7b73b09b5ed3fa3532de1747c" name="adfef15ef4e76cc55d652fbd9c2797297a8c068cf7b73b09b5ed3fa3532de1747c"></a>S_LOW_LVL_UNEXPECTED_STREAM_PAYLOAD_BEYOND_HNDL&#160;</td><td class="fielddoc"><p >Unable to receive incoming traffic: message contains more than: 1 blob plus 0-1 native handles. </p>
</td></tr>
<tr><td class="fieldname"><a id="adfef15ef4e76cc55d652fbd9c2797297adde24987f30a92b953297207ce935210" name="adfef15ef4e76cc55d652fbd9c2797297adde24987f30a92b953297207ce935210"></a>S_MESSAGE_SIZE_EXCEEDS_USER_STORAGE&#160;</td><td class="fielddoc"><p >User protocol-code mismatch: local user-provided storage cannot fit entire message received from opposing peer. </p>
</td></tr>
<tr><td class="fieldname"><a id="adfef15ef4e76cc55d652fbd9c2797297ae3753569086cc66c6165480bd8d2f937" name="adfef15ef4e76cc55d652fbd9c2797297ae3753569086cc66c6165480bd8d2f937"></a>S_BLOB_RECEIVER_GOT_NON_BLOB&#160;</td><td class="fielddoc"><p >User protocol-code mismatch: local user expected blob only and no native handle; received at least the latter. </p>
</td></tr>
<tr><td class="fieldname"><a id="adfef15ef4e76cc55d652fbd9c2797297aba920b52e9801e4927dd346ad83ce815" name="adfef15ef4e76cc55d652fbd9c2797297aba920b52e9801e4927dd346ad83ce815"></a>S_RECEIVER_IDLE_TIMEOUT&#160;</td><td class="fielddoc"><p >No messages (optional auto-pings or otherwise) have been received; optionally configured timeout exceeded. </p>
<p >If a <a class="el" href="classipc_1_1session_1_1Session.html" title="A documentation-only concept defining the local side of an IPC conversation (session) with another en...">session::Session</a> emitted this error, the session is now hosed due to master channel idle timeout indicating poor health of the opposing side or the system. </p>
</td></tr>
<tr><td class="fieldname"><a id="adfef15ef4e76cc55d652fbd9c2797297a41cb789a6a5da26e1f72139206cb9adf" name="adfef15ef4e76cc55d652fbd9c2797297a41cb789a6a5da26e1f72139206cb9adf"></a>S_PROTOCOL_NEGOTIATION_OPPOSING_VER_INVALID&#160;</td><td class="fielddoc"><p >In protocol negotiation, opposing side sent invalid version value (not positive, not a number, etc.); the comm pathway must close. </p>
</td></tr>
<tr><td class="fieldname"><a id="adfef15ef4e76cc55d652fbd9c2797297a594bf33052a89403c734f24428007c80" name="adfef15ef4e76cc55d652fbd9c2797297a594bf33052a89403c734f24428007c80"></a>S_PROTOCOL_NEGOTIATION_OPPOSING_VER_TOO_OLD&#160;</td><td class="fielddoc"><p >In protocol negotiation, opposing side reported its newest protocol version is even older than the most backwards-compatible (oldest, smallest) version we speak; the comm pathway must close. </p>
</td></tr>
<tr><td class="fieldname"><a id="adfef15ef4e76cc55d652fbd9c2797297ac416e988563e44bf15fc6a81743eef53" name="adfef15ef4e76cc55d652fbd9c2797297ac416e988563e44bf15fc6a81743eef53"></a>S_INVALID_ARGUMENT&#160;</td><td class="fielddoc"><p >User called an API with 1 or more arguments against the API spec. </p>
</td></tr>
<tr><td class="fieldname"><a id="adfef15ef4e76cc55d652fbd9c2797297abcfca4c2347f9d377dd2ac41c41dc027" name="adfef15ef4e76cc55d652fbd9c2797297abcfca4c2347f9d377dd2ac41c41dc027"></a>S_TIMEOUT&#160;</td><td class="fielddoc"><p >A (usually user-specified) timeout period has elapsed before a blocking operation completed. </p>
</td></tr>
<tr><td class="fieldname"><a id="adfef15ef4e76cc55d652fbd9c2797297a291f8a813c292ccdb475c345181653ac" name="adfef15ef4e76cc55d652fbd9c2797297a291f8a813c292ccdb475c345181653ac"></a>S_INTERRUPTED&#160;</td><td class="fielddoc"><p >A blocking operation was intentionally interrupted or preemptively canceled. </p>
</td></tr>
<tr><td class="fieldname"><a id="adfef15ef4e76cc55d652fbd9c2797297afe29343445a7bf167cc186a44bd2c6ed" name="adfef15ef4e76cc55d652fbd9c2797297afe29343445a7bf167cc186a44bd2c6ed"></a>S_OBJECT_SHUTDOWN_ABORTED_COMPLETION_HANDLER&#160;</td><td class="fielddoc"><p >Async completion handler is being called prematurely, because underlying object is shutting down, as user desires. </p>
</td></tr>
<tr><td class="fieldname"><a id="adfef15ef4e76cc55d652fbd9c2797297a9ee20939f859e44681c24f6d153cc36b" name="adfef15ef4e76cc55d652fbd9c2797297a9ee20939f859e44681c24f6d153cc36b"></a>S_MQ_MESSAGE_SIZE_OVER_OR_UNDERFLOW&#160;</td><td class="fielddoc"><p >Low-level message queue send-op buffer overflow (&gt; max size) or receive-op buffer underflow (&lt; max size). </p>
</td></tr>
<tr><td class="fieldname"><a id="adfef15ef4e76cc55d652fbd9c2797297a515698d19c829006a0803477fb605ae3" name="adfef15ef4e76cc55d652fbd9c2797297a515698d19c829006a0803477fb605ae3"></a>S_MQ_BIPC_MISC_LIBRARY_ERROR&#160;</td><td class="fielddoc"><p >Low-level message queue: boost.interprocess emitted miscellaneous library exception sans a system code; a WARNING message at throw-time should contain all possible details. </p>
</td></tr>
<tr><td class="fieldname"><a id="adfef15ef4e76cc55d652fbd9c2797297a5026917d99ad25df8bc708cc6628f28c" name="adfef15ef4e76cc55d652fbd9c2797297a5026917d99ad25df8bc708cc6628f28c"></a>S_BLOB_STREAM_MQ_SENDER_EXISTS&#160;</td><td class="fielddoc"><p >Message-queue blob stream outgoing-direction peer could not be created, because one already exists at that name. </p>
</td></tr>
<tr><td class="fieldname"><a id="adfef15ef4e76cc55d652fbd9c2797297af6ee4717280d29cc272ef2a356ad3982" name="adfef15ef4e76cc55d652fbd9c2797297af6ee4717280d29cc272ef2a356ad3982"></a>S_BLOB_STREAM_MQ_RECEIVER_EXISTS&#160;</td><td class="fielddoc"><p >Message-queue blob stream incoming-direction peer could not be created, because one already exists at that name. </p>
</td></tr>
<tr><td class="fieldname"><a id="adfef15ef4e76cc55d652fbd9c2797297a0ba1798bc135b43eebd7ce2481151348" name="adfef15ef4e76cc55d652fbd9c2797297a0ba1798bc135b43eebd7ce2481151348"></a>S_BLOB_STREAM_MQ_RECEIVER_BAD_CTL_CMD&#160;</td><td class="fielddoc"><p >Message-queue blob stream peer received a malformed internal-use message from opposing side. </p>
</td></tr>
<tr><td class="fieldname"><a id="adfef15ef4e76cc55d652fbd9c2797297aa667487757f9d6300f6888bac40bcc24" name="adfef15ef4e76cc55d652fbd9c2797297aa667487757f9d6300f6888bac40bcc24"></a>S_SYNC_IO_WOULD_BLOCK&#160;</td><td class="fielddoc"><p >A <a class="el" href="namespaceipc_1_1transport_1_1sync__io.html" title="sync_io-pattern counterparts to async-I/O-pattern object types in parent namespace ipc::transport.">sync_io</a> operation could not immediately complete; it will complete contingent on active async-wait event(s). </p>
</td></tr>
<tr><td class="fieldname"><a id="adfef15ef4e76cc55d652fbd9c2797297a6fba12db09e5bebfaa04f6372c41c2cf" name="adfef15ef4e76cc55d652fbd9c2797297a6fba12db09e5bebfaa04f6372c41c2cf"></a>S_END_SENTINEL&#160;</td><td class="fielddoc"><p >SENTINEL: Not an error. This Code must never be issued by an error/success-emitting API; I/O use only. </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="aa825718d46992654588588b09a0f1be6" name="aa825718d46992654588588b09a0f1be6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa825718d46992654588588b09a0f1be6">&#9670;&nbsp;</a></span>make_error_code()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a> ipc::transport::error::make_error_code </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297">Code</a>&#160;</td>
          <td class="paramname"><em>err_code</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Given a <code>Code</code> <code>enum</code> value, creates a lightweight <a class="el" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89" title="Short-hand for flow::Error_code which is very common.">Error_code</a> (a/k/a <a class="el" href="namespaceboost_1_1system.html" title="Small group of miscellaneous utilities to ease work with boost.system, joining its boost::system name...">boost.system</a> <code>error_code</code>) representing that error. </p>
<p >This is needed to make the <code>boost::system::error_code::error_code&lt;Code&gt;()</code> template implementation work. Or, slightly more in English, it glues the (completely general) <a class="el" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89" title="Short-hand for flow::Error_code which is very common.">Error_code</a> to the (<code><a class="el" href="namespaceipc_1_1transport.html" title="Flow-IPC module providing transmission of structured messages and/or low-level blobs (and more) betwe...">ipc::transport</a></code>-specific) error code set <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297" title="All possible errors returned (via Error_code arguments) by ipc::transport functions/methods outside o...">ipc::transport::error::Code</a>, so that one can implicitly covert from the latter to the former.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">err_code</td><td>The <code>enum</code> value. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A corresponding <a class="el" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89" title="Short-hand for flow::Error_code which is very common.">Error_code</a>. </dd></dl>

</div>
</div>
<a id="a4686a04e7ab89d4be42548cbb5b37975" name="a4686a04e7ab89d4be42548cbb5b37975"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4686a04e7ab89d4be42548cbb5b37975">&#9670;&nbsp;</a></span>operator&lt;&lt;()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::ostream &amp; ipc::transport::error::operator&lt;&lt; </td>
          <td>(</td>
          <td class="paramtype">std::ostream &amp;&#160;</td>
          <td class="paramname"><em>os</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297">Code</a>&#160;</td>
          <td class="paramname"><em>val</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Serializes a <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297" title="All possible errors returned (via Error_code arguments) by ipc::transport functions/methods outside o...">transport::error::Code</a> to a standard output stream. </p>
<p >The output string is compatible with the reverse <code>istream&gt;&gt;</code> operator.</p>
<h3>Rationale</h3>
<p >This shall print a representation that looks like the identifier in C++ code; e.g., <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297ac416e988563e44bf15fc6a81743eef53" title="User called an API with 1 or more arguments against the API spec.">Code::S_INVALID_ARGUMENT</a> =&gt; <code>"INVALID_ARGUMENT"</code>. Nevertheless, when printing an <a class="el" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89" title="Short-hand for flow::Error_code which is very common.">Error_code</a> storing a Code, continue to do the standard thing: output the <a class="el" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89" title="Short-hand for flow::Error_code which is very common.">Error_code</a> (which will print the category name, in our case, something like <code>"ipc/transport"</code>; and the numeric <code>enum</code> value) itself plus its <code>.message()</code> (which will print a natural-language message). Naturally that technique will work with any <a class="el" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89" title="Short-hand for flow::Error_code which is very common.">Error_code</a>, including but <em>not</em> limited to one storing a Code.</p>
<p >So why does the present <code>operator&lt;&lt;</code> even exist? Answer: Primarily it's in order to enable a consistent, yet human-friendly, machinery of serializing/deserializing <code>Code</code>s. No such machinery exists for general <a class="el" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89" title="Short-hand for flow::Error_code which is very common.">Error_code</a>, and specifying an <a class="el" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89" title="Short-hand for flow::Error_code which is very common.">Error_code</a> in an input stream would probably invovle (at least) providing a numeric value; but we can still provide a symbolic [de]serialization for specifically <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297" title="All possible errors returned (via Error_code arguments) by ipc::transport functions/methods outside o...">transport::error::Code</a>. Why did we want that? Answer: The original use case was in testing scenarios, to easily specify an expected outcome of an <a class="el" href="namespaceipc_1_1transport.html" title="Flow-IPC module providing transmission of structured messages and/or low-level blobs (and more) betwe...">ipc::transport</a> API call symbolically instead of resorting to numeric <code>enum</code> values (it's nicer to say "expect INVALID_ARGUMENT" rather than "expect 13" &ndash; though incidentally the latter also works).</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">os</td><td>Stream to which to serialize. </td></tr>
    <tr><td class="paramname">val</td><td>Value to serialize. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>os</code>. </dd></dl>

</div>
</div>
<a id="a64595c41a5810937c39733230628c499" name="a64595c41a5810937c39733230628c499"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a64595c41a5810937c39733230628c499">&#9670;&nbsp;</a></span>operator&gt;&gt;()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::istream &amp; ipc::transport::error::operator&gt;&gt; </td>
          <td>(</td>
          <td class="paramtype">std::istream &amp;&#160;</td>
          <td class="paramname"><em>is</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297">Code</a> &amp;&#160;</td>
          <td class="paramname"><em>val</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Deserializes a <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297" title="All possible errors returned (via Error_code arguments) by ipc::transport functions/methods outside o...">transport::error::Code</a> from a standard input stream. </p>
<p >Reads up to but not including the next non-alphanumeric-or-underscore character; the resulting string is then mapped to a log::Sev. If none is recognized, <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297a6fba12db09e5bebfaa04f6372c41c2cf" title="SENTINEL: Not an error. This Code must never be issued by an error/success-emitting API; I/O use only...">Code::S_END_SENTINEL</a> is the result. The recognized values are:</p><ul>
<li>"1", "2", ...: Corresponds to the <code>int</code> conversion of that Code.</li>
<li>Case-insensitive encoding of the non-S_-prefix part of the actual Code member; e.g., "INVALID_ARGUMENT" (or "invalid_argument" or "Invalid_argument" or...) for <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297ac416e988563e44bf15fc6a81743eef53" title="User called an API with 1 or more arguments against the API spec.">Code::S_INVALID_ARGUMENT</a>. This enables a few I/O things to work, including parsing from config file/command line via and conversion from <code>string</code> via <code>boost::lexical_cast</code>.</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">is</td><td>Stream from which to deserialize. </td></tr>
    <tr><td class="paramname">val</td><td>Value to set. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>is</code>. </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 11 2025 20:02:23 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
